home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / DISK / KBFM12.ARJ / FM.DOC next >
Text File  |  1992-07-30  |  27KB  |  581 lines

  1.  
  2.                                 KB-File Manager
  3.                                   Version 1.2
  4.                        Copyright (C) 1992 by Kent Briggs
  5.  
  6.  
  7.                                  Introduction
  8.                                  ------------
  9.  
  10.        KB-File Manager (KB-FM) is an easy to use, yet powerful DOS file
  11.        manager that lets the user copy, move, delete, and perform other
  12.        functions on individual files or groups of files.  Files are
  13.        selected by "tagging" them on the screen and then processing them
  14.        through a "Lotus" style menu.  Safeguards are built in to prevent
  15.        a file from being overwritten without your permission.  KB-FM is
  16.        for people who want a more powerful utility than the PC-Magazine
  17.        "CO.COM" program but don't want to shell out $100 for a commercial
  18.        program like "XTree Gold."
  19.  
  20.  
  21.                                  Distribution
  22.                                  ------------
  23.  
  24.        KB-FM is distributed as Shareware with a registration fee of $10.
  25.        Shareware is a "try before you buy" concept where users are
  26.        encouraged to share the programs with friends and business
  27.        associates, upload to electronic bulletin board systems (BBS), etc.
  28.        Those that find the programs useful should register their copy to
  29.        support the author's efforts and to receive technical support or
  30.        other benefits.
  31.  
  32.        KB-FM is distributed in a compressed format in a file called
  33.        KBFM12.ZIP.  The compressed file contains the following files that
  34.        must stay together for distribution:
  35.  
  36.        FM.EXE          KB-FM Program
  37.        FM.DOC          KB-FM Documentation (10 pages)
  38.        FMCONFIG.EXE    KB-FM Configuration program for registered users
  39.        ORDER.FRM       KB-FM Registration order form
  40.        README.1ST      KB-FM Description file
  41.  
  42.  
  43.                                FMCONFIG Program
  44.                                ----------------
  45.  
  46.        The shareware version of KB-FM has black and white screen colors
  47.        and an opening message screen with a three-second pause.  No
  48.        operating functions of KB-FM are crippled.  As an additional
  49.        incentive to register, a unique serial number will be sent to
  50.        registered users.  This serial number is used by the FMCONFIG
  51.        program to disable the opening message screen and will let the user
  52.        customize the KB-FM screen colors. The user can select from a
  53.        default black and white or color configuration, or make a custom
  54.        color configuration by selecting individual colors for 11 separate
  55.  
  56.  
  57.                                      1
  58.  
  59.  
  60.        areas of the screen.  FMCONFIG will also personalize your
  61.        registered copy of KB-FM by placing your name (or company name) and
  62.        serial number on the help screen.
  63.  
  64.  
  65.                                  Registration
  66.                                  ------------
  67.  
  68.        To register your copy of KB-File Manager, print the order form,
  69.        fill it out and send in your registration fee.  You can use the
  70.        following DOS command to print the order form:
  71.  
  72.        COPY ORDER.FRM PRN
  73.  
  74.        There are four line items on the order form:
  75.  
  76.        1. KB-FM Registration (no disk)   :  $10
  77.        2. KB-FM Diskette, 5.25"          :   $3
  78.        3. KB-FM Diskette, 3.5"           :   $3
  79.        4. KB-FM Site License Registration: $150
  80.  
  81.        Item 1 is the normal registration option for users who already have
  82.        the KB-FM shareware files and just need the serial number for the
  83.        FMCONFIG program.  No disks are provided.  Your serial number will
  84.        be valid for all future versions of KB-FM that have a $10
  85.        registration fee.  This means that you can self-upgrade at no cost.
  86.        If the registration fee is raised, then you can upgrade to a new
  87.        serial number by paying the difference between the new fee and the
  88.        fee you originally paid.
  89.  
  90.        Items 2 and 3 are disks that contain the same shareware files that
  91.        are distributed through the normal shareware channels.  These are
  92.        for people who have read about KB-FM but do not have a modem or
  93.        other means of obtaining the latest version.  The $3 charge is to
  94.        cover my costs of materials and postage.  A registration serial
  95.        number is NOT provided with items 2 or 3.
  96.  
  97.        Item 4 is a site license for companies who need more than 15 copies
  98.        of KB-FM.  With a site license, you may make unlimited copies of
  99.        KB-FM for use on the site.  A site is defined as one or more
  100.        buildings used by a company or institution on a contiguous area of
  101.        land.  The site license includes a registration serial number and
  102.        a 5.25" and 3.5" disk.  You may upgrade to a site license at any
  103.        time by subtracting $10 for every registered copy you already have
  104.        from the $150 site license fee.
  105.  
  106.        When ordering items 1 or 4, please include the name that KB-FM will
  107.        be registered to.  This name (30 characters max) will be placed on
  108.        the help screen by the FMCONFIG program.
  109.  
  110.        For orders or technical support, write to:
  111.  
  112.        Kent Briggs
  113.        109A Romana Cir.
  114.        Hewitt, TX  76643
  115.                                      2
  116.  
  117.  
  118.                                   Disclaimer
  119.                                   ----------
  120.  
  121.        This software is provided as is and without warranty.  The author
  122.        assumes no liability for damages, either direct or consequential,
  123.        which may result from the use of this product.
  124.  
  125.  
  126.                                  Installation
  127.                                  ------------
  128.  
  129.        No special installation is needed to run KB-FM.  However, you will
  130.        probably want to put FM.EXE in your DOS path so that it will
  131.        execute from any directory.  The DOS path is defined in your
  132.        AUTOEXEC.BAT file and lists a string of directories that are
  133.        searched if DOS cannot find a program in the current directory.
  134.        Put FM.EXE in one of those directories or modify the PATH statement
  135.        so that it contains the KB-FM directory.  Refer to your DOS manual
  136.        for use of the PATH command.
  137.  
  138.        To start KB-FM, type FM at the DOS command line and press Enter.
  139.        You may enter optional parameters on the command line:
  140.  
  141.        FM [pathspec][filespec] [/N,/E,/S,/D,/A,/U][R]
  142.  
  143.        Pathspec is the directory that KB-FM will display on startup.  The
  144.        default directory is the current directory.  The Filespec is the
  145.        file name filter that determines which files to display.  The
  146.        default filespec is *.* which displays all files.  The / options
  147.        determine the file sort order: N=name, E=extension, S=size, D=date,
  148.        A=attribute, and U=unsorted.  Use an R suffix to reverse the sort.
  149.        The default sort is /N.  The following example will show the batch
  150.        files in the root directory on drive A and sort them by date in
  151.        reverse order:
  152.  
  153.        FM A:\*.BAT /DR
  154.  
  155.  
  156.                                  KB-FM Screen
  157.                                  ------------
  158.  
  159.        The screen is divided into three main areas that contain
  160.        information about the current directory.  The File List is the
  161.        large box on the left side of the screen.  It contains the list of
  162.        files in the current directory that match the filespec.  The list
  163.        contains the file name and extension, size, date and time, and
  164.        attributes.  The four possible attributes are A for archive, S for
  165.        system, H for hidden, and R for read-only.  Refer to your DOS
  166.        manual for a description of file attributes.  The file list is
  167.        sorted by the current sort order.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.                                      3
  174.  
  175.  
  176.        The Directory List is the box in the upper right corner of the
  177.        screen. This list contains the subdirectories of the current
  178.        directory and all of the logical drives on the computer.  The name
  179.        of the current directory is displayed at the bottom of the
  180.        directory list in a separate box.  The number of subdirectories and
  181.        drives are displayed under the directory list.  If the current
  182.        directory is not a root directory, then the first item in the
  183.        directory list will always be a ".." which represents the parent
  184.        directory of the current directory.  The date and time that the
  185.        directory was created are also shown in the list.  The directory
  186.        list is always sorted by name in ascending order.  Hidden
  187.        directories are not displayed in the list.  However, you can
  188.        use KB-FM in a hidden directory by changing to the hidden directory
  189.        with the DOS CD command and then running FM.EXE or by placing the
  190.        directory name on the FM.EXE command line.
  191.  
  192.        The box in the lower right corner of the screen contains additional
  193.        information about the files in the current directory.  The filespec
  194.        shows the current file name filter that determines which files are
  195.        displayed.  The default filespec is *.* which displays all files.
  196.        The current file sort order is shown under the filespec.  "Rev"
  197.        will be displayed if the sort is in reverse (descending) order.
  198.        Both the filespec and sort order can be set from the FM.EXE command
  199.        line or changed from the top line menu.  The filespec and sort
  200.        order remain in effect even after changing directories.
  201.  
  202.        Below the Filespec/Sort order box is the Tagged files box that
  203.        displays the number and total size of tagged files.  Files can be
  204.        tagged with the + key and untagged with the - key (use the numeric
  205.        keypad).  Files are tagged so that they can be processed (copied,
  206.        deleted, etc.) all at once instead of one at a time.
  207.  
  208.        The bottom line of the screen contains information on the number
  209.        and total size of the files in the file list and the number and
  210.        percentage of free disk space on the current drive.  The menus are
  211.        displayed on the top line of the screen when the / key is pressed.
  212.  
  213.  
  214.                                   Active Keys
  215.                                   -----------
  216.  
  217.        Scrolling:  Press the left and right cursor keys or the Tab key to
  218.        move the highlight bar between the file list and directory list.
  219.        Press the up and down cursor keys to scroll the highlight bar in
  220.        the file and directory lists.  Press PageUp and PageDown to scroll
  221.        a whole page of files or directories.  Press Home to move to the
  222.        top of the lists and End to move to the bottom.  A down arrow will
  223.        appear at the bottom of the list if more files (or directories) are
  224.        in the list below the last one shown.  An up arrow will appear at
  225.        the top of the list if more files (or directories) are in the list
  226.        above the first one shown.
  227.  
  228.  
  229.  
  230.  
  231.                                      4
  232.  
  233.  
  234.        Change Dir:    With the highlight bar in the directory list, press
  235.                       Enter to change to that directory.  If the
  236.                       highlight bar is on the ".." directory, then the
  237.                       new directory will be the parent of the current
  238.                       directory.  If the highlight bar is on a drive,
  239.                       then the new directory will be the current
  240.                       directory on the new drive.
  241.  
  242.        File Tagging:  With the highlight bar in the file list, press the
  243.                       + key (use the numeric keypad) to tag the current
  244.                       file.  An arrow will appear on the left side of the
  245.                       file name.  Press - to untag a file.
  246.  
  247.        File Viewing:  With the highlight bar in the file list, press
  248.                       Enter to view the current file in ASCII (text)
  249.                       format.  Binary files can also be viewed but each
  250.                       byte will be converted to its ASCII equivalent
  251.                       character.  Only the first 9999 lines of the file
  252.                       can be viewed.  Lines wider than 255 characters
  253.                       will be wrapped.  Use the cursor, PageUp/PageDn,
  254.                       and Home/End keys for scrolling.  Press Esc to exit
  255.                       the file viewer.  Files with an "R" attribute can
  256.                       not be viewed.  Use the Attributes command to
  257.                       change file attributes.
  258.  
  259.        Run Program:   With the highlight bar on a file with a COM, EXE,
  260.                       or BAT extension, press Enter to display the
  261.                       following menu:
  262.  
  263.                       FILE:  Execute  View
  264.  
  265.                       Select View to view the file as described above.
  266.                       Select Execute to load and run the program.  KB-FM
  267.                       remains in memory so programs requiring more than
  268.                       approximately 350K RAM will probably not run.
  269.                       KB-FM regains control when you exit the loaded
  270.                       program.
  271.  
  272.        Menus:         With the highlight bar in the file list, press / to
  273.                       display the File Menu on the top line.  With the
  274.                       highlight bar in the directory list, press / to
  275.                       display the Directory Menu on the top line.  Press
  276.                       Esc or the down arrow to remove the top line menu.
  277.  
  278.        File Search:   Press any other key to search for a file (or
  279.                       directory) that begins with that character (i.e.,
  280.                       press P to search for a file name that begins with
  281.                       P).  The search begins at the highlight bar and
  282.                       goes down until a match is found or until the
  283.                       bottom of the list is reached at which time the
  284.                       search will continue at the top of the list and
  285.                       continue until the original starting point is
  286.                       reached.  If a match is found, the highlight bar
  287.                       will be moved to that file (or directory).
  288.  
  289.                                      5
  290.  
  291.  
  292.                                 Directory Menu
  293.                                 --------------
  294.  
  295.        With the highlight bar in the directory list, press / to display
  296.        the directory menu:
  297.  
  298.        DIRECTORY:  Make  Remove  Help  Quit
  299.  
  300.        To select a menu item, press the left or right cursor keys until
  301.        the item is highlighted and then press Enter.  As a shortcut, just
  302.        press the key corresponding to the first letter in the menu item.
  303.        Press Esc or the down arrow key to cancel the menu.
  304.  
  305.        Make:     Select Make to make a new subdirectory in the current
  306.                  directory.  This is the same as the DOS MD command.  A
  307.                  prompt will appear like this:
  308.  
  309.                  New subdirectory for C:\
  310.  
  311.                  Type in a valid directory name and press Enter or press
  312.                  Esc to cancel.
  313.  
  314.        Remove:   Select Remove to remove the directory that is currently
  315.                  highlighted.  This is the same as the DOS RD command.  A
  316.                  Yes/No conformation prompt will appear before the
  317.                  directory is removed.  An error message will be displayed
  318.                  if the directory is not empty.
  319.  
  320.        Help:     Select Help to display the help screen.  If you are a
  321.                  registered user, your name and registration serial number
  322.                  will be displayed.  A list of the active keys and menu
  323.                  functions are listed on this screen.  Press any key to
  324.                  return from the help screen.
  325.  
  326.        Quit:     Select Quit to exit the KB-FM program.
  327.  
  328.  
  329.                                    File Menu
  330.                                    ---------
  331.  
  332.        With the highlight bar in the file list, press / to display the
  333.        file menu:
  334.  
  335.        FILE:     Copy  Move  Delete  Rename  Sort  Tag  Filespec
  336.                  Attribute  Help  Quit
  337.  
  338.        To select a menu item, press the left or right cursor keys until
  339.        the item is highlighted and then press Enter.  As a shortcut, just
  340.        press the key corresponding to the first letter in the menu item.
  341.        Press Esc or the down arrow key to cancel the menu.
  342.  
  343.  
  344.  
  345.  
  346.  
  347.                                      6
  348.  
  349.  
  350.        Copy:     Select Copy to copy files from the current directory to
  351.                  a designated destination directory.  If one or more files
  352.                  are tagged, then the tagged files will be copied.  A
  353.                  prompt will appear like this:
  354.  
  355.                  Copy 3 tagged file(s) to: _
  356.  
  357.                  If no files are tagged, then the current highlighted file
  358.                  is copied.  A prompt will appear like this:
  359.  
  360.                  Copy KBFM10.ZIP to: _
  361.  
  362.                  Type in a valid directory just as you would using the DOS
  363.                  COPY command or press Esc to cancel the Copy command.
  364.                  KB-FM will ensure that the destination drive/directory
  365.                  exists before an attempt is made to copy the files.  The
  366.                  arrow "tag" is removed after a successful copy and the
  367.                  file is "marked" with an asterisk.
  368.  
  369.                  If an error occurs during the copy process, the speaker
  370.                  will beep and a brief error message will be displayed.
  371.                  The copy process will continue if other files in the list
  372.                  are tagged.  You can press any key to interrupt the copy
  373.                  process.  An error will occur if the file has attributes
  374.                  other than "A" (archive) or if the destination drive is
  375.                  full.
  376.  
  377.                  If a file with the same name already exists in the
  378.                  destination directory, the copy process is interrupted
  379.                  with the following prompt like this:
  380.  
  381.                  KBFM10.ZIP already exists.
  382.                  (R)eplace, (S)kip, (N)o_prompting, (Q)uit?
  383.  
  384.                  Press R to overwrite the file and continue the copy
  385.                  process.  Press S to skip the file and continue with the
  386.                  next tagged file.  Press N to overwrite the file and all
  387.                  other files that might already exist.  Press Q to cancel
  388.                  the Copy command.
  389.  
  390.        Move:     Select Move to move files from the current directory to
  391.                  a designated destination directory.  If one or more files
  392.                  are tagged, then the tagged files will be moved.  A
  393.                  prompt will appear like this:
  394.  
  395.                  Move 3 tagged file(s) to: _
  396.  
  397.                  If no files are tagged, then the current highlighted file
  398.                  is moved.  A prompt will appear like this:
  399.  
  400.                  Move KBFM10.ZIP to: _
  401.  
  402.  
  403.  
  404.  
  405.                                      7
  406.  
  407.  
  408.                  Type in a valid directory just as you would using the DOS
  409.                  COPY command (there is no DOS MOVE command) or press Esc
  410.                  to cancel the Move command.  KB-FM will ensure that the
  411.                  destination drive/directory exists before an attempt is
  412.                  made to move the files.
  413.  
  414.                  The move process is the same as the Copy command except
  415.                  the files are deleted if they are successfully copied.
  416.  
  417.        Delete:   Select Delete to delete files from the current directory.
  418.                  If one or more files are tagged, then the tagged files
  419.                  will be deleted.  A prompt will appear like this:
  420.  
  421.                  Delete 3 tagged file(s) (Y/N) ?
  422.  
  423.                  If no files are tagged, then the current highlighted file
  424.                  is deleted.  A prompt will appear like this:
  425.  
  426.                  Delete KBFM10.ZIP (Y/N) ?
  427.  
  428.                  Press Y to delete the file(s) or any other key to cancel
  429.                  the delete command.  A file will not be deleted if it has
  430.                  attributes other than "A" (archive).
  431.  
  432.        Rename:   Select Rename to give the current highlighted file a
  433.                  different name.  Other tagged files are not affected.  A
  434.                  prompt will appear like this:
  435.  
  436.                  Rename KBFM10.ZIP to: _
  437.  
  438.                  Type in a valid DOS filename or press Esc to cancel the
  439.                  Rename command.  An error will occur if the name is
  440.                  invalid or another file with the same name already
  441.                  exists.
  442.  
  443.        Sort:     Select Sort to set the sort order for the current
  444.                  directory and all subsequent directories.  A submenu will
  445.                  appear as follows:
  446.  
  447.                  Sort by:  Name  Extension  Size  Date  Attribute
  448.                            Unsorted  Reverse
  449.  
  450.                  Select the file sort order from this list.  Select
  451.                  Unsorted to reload the current directory and leave it in
  452.                  the original DOS order.  Select Reverse to reverse the
  453.                  current sort order with a descending sort.  The current
  454.                  sort order is displayed in the lower right box on the
  455.                  screen.  The sort order remains in effect until you
  456.                  change it again.  The default sort order is by Name and
  457.                  can be changed from the FM.EXE command line (see the
  458.                  Installation section discussed earlier).
  459.  
  460.  
  461.  
  462.  
  463.                                      8
  464.  
  465.  
  466.        Tag:      Select Tag to tag or untag a group of files all at once.
  467.                  Individual files are tagged/untagged with the +/- keys.
  468.                  A submenu will appear as follows:
  469.  
  470.                  Tag:  All  None  Marked  Unmarked  Flip
  471.  
  472.                  Select All to tag all files in the list.  Select None to
  473.                  untag and unmark all files in the list.  Select Marked to
  474.                  tag all files that are marked with an asterisk.  These
  475.                  files have recently been copied or had their attributes
  476.                  changed.  Select Unmarked to tag all files that are
  477.                  currently marked with an asterisk.  Select Flip to tag
  478.                  all untagged files and to untag all tagged files.  Marked
  479.                  files remain marked with an asterisk.
  480.  
  481.        Filespec: Select Filespec to change the current filespec.  The
  482.                  filespec is the file name filter that determines which
  483.                  files to display.  A prompt will appear as follows:
  484.  
  485.                  Enter new filespec: _
  486.  
  487.                  Type in a new filespec or press Esc to cancel.  The
  488.                  default filespec is *.* which displays all files.  The
  489.                  current filespec remains in effect until you change it
  490.                  again.  You can change the default filespec from the
  491.                  FM.EXE command line (see Installation section).  Here are
  492.                  some filespec examples:
  493.  
  494.                  *.DOC      ; display only files with an extension of .DOC
  495.                  K*.*       ; display only files that start with a K
  496.  
  497.                  Attribute: Select Attribute to change the attributes of
  498.                  files in the current directory.  If one or more files are
  499.                  tagged, then the tagged files will be changed.  A prompt
  500.                  will appear like this:
  501.  
  502.                  Change attributes of 3 tagged files(s) to (+/-ASHR): _
  503.  
  504.                  If no files are tagged, then the attributes of the
  505.                  current highlighted file are changed.  A prompt will
  506.                  appear like this:
  507.  
  508.                  Change attributes of KBFM10.ZIP to (+/-ASHR): _
  509.  
  510.                  The four possible attributes are A for archive, S for
  511.                  system, H for hidden, and R for read-only.  Refer to your
  512.                  DOS manual for a description of file attributes.
  513.  
  514.                  Type in the attributes to change by preceding each one
  515.                  with a + to turn on or a - to turn off.  Press Esc to
  516.                  cancel the Attribute command.  Here are some examples:
  517.  
  518.  
  519.  
  520.  
  521.                                      9
  522.  
  523.                  +H-S      ; turn on H attribute and turn off S attribute
  524.                            ; the A and R attributes are not affected.
  525.  
  526.                  -H-S-R-A  ; turn off all attributes
  527.  
  528.        Help:     Select Help to display the help screen.  If you are a
  529.                  registered user, your name and registration serial number
  530.                  will be displayed.  A list of the active keys and menu
  531.                  functions are listed on this screen.  Press any key to
  532.                  return from the help screen.
  533.  
  534.        Quit:     Select Quit to exit the KB-FM program.
  535.  
  536.  
  537.                                  Miscellaneous
  538.                                  -------------
  539.  
  540.        KB-File Manager was written in Turbo Pascal 6.0 (approximately 2500
  541.        lines of code) on a Gateway 2000 486DX2/50 computer.  The program
  542.        was beta tested on several types of computers including
  543.        workstations on a LANtastic network.
  544.  
  545.        Here are some features that I am considering for future versions:
  546.  
  547.        File editor (link in your own editor)
  548.        PKZIP support (tag files to compress, uncompress)
  549.        Laplink-like functions (transfer files over null-modem cable)
  550.        Mouse support
  551.  
  552.        Please send your own suggestions to:
  553.  
  554.        Kent Briggs
  555.        109A Romana Cir.
  556.        Hewitt, TX  76643
  557.  
  558.        You can also leave e-mail addressed to me on the Exec-PC BBS at
  559.        (414)-789-4210.  Exec-PC is PC-Pursuitable through WIMIL.
  560.  
  561.  
  562.                                 Program History
  563.                                 ---------------
  564.        Ver 1.0  06/12/92
  565.        Initial release.
  566.  
  567.        Ver 1.1  06/12/92
  568.        Bug fix.  The box showing the number of tagged files did not update
  569.        after using the Attributes command on tagged files.
  570.  
  571.        Ver 1.2  07/30/92
  572.        Added two new features: Text file viewer and COM/EXE/BAT program
  573.        execution.
  574.                                ---------------
  575.  
  576.  
  577.  
  578.  
  579.                                     10
  580.  
  581.